Rell System Library/[root]/integer

integer

Represents a 64-bit signed integer

Since

0.6.0

Constructors

pure constructor(value: text, [radix: integer])

Parses a signed string representation of an integer.

pure constructor(value: decimal)

Converts a decimal to an integer, rounding towards 0.

Properties

val MAX_VALUE: integer = 9223372036854775807

A constant representing the maximum value an integer can have (9223372036854775807)

val MIN_VALUE: integer = -9223372036854775808

A constant representing the minimum value an integer can have (-9223372036854775808)

Functions

pure function abs(): integer

Calculates the absolute value of the integer.

pure static function from_hex(value: text): integer

Parses an unsigned hexadecimal representation of an integer.

pure static function from_text(value: text, [radix: integer]): integer

Parses a signed string representation of an integer.

(alias) pure function ~~hex~~(): text

Converts this integer to a hexadecimal string.

Alias

pure function max(value: big_integer): big_integer

Finds the maximum of this integer and the given big integer value.

pure function max(value: decimal): decimal

Finds the maximum of this integer and the given decimal value.

pure function max(value: integer): integer

Finds the maximum of this integer and the given value.

pure function min(value: big_integer): big_integer

Finds the minimum of this integer and the given big integer value.

pure function min(value: decimal): decimal

Finds the minimum of this integer and the given decimal value.

pure function min(value: integer): integer

Finds the minimum of this integer and the given value.

(alias) pure static function ~~parseHex~~(value: text): integer

Parses an unsigned hexadecimal representation of an integer.

Alias

pure function pow(exponent: integer): integer

Raises this integer to the power of the given exponent. Can be used in a database at-expression.

The exponent cannot be negative.
Error on overflow, if the result is out of integer or integer range.
Beware that the result of integer.pow() is limited to the 64-bit signed integer range, so the operation like (2).pow(64) will overflow - use big_integer.pow() to get a big_integer result, e.g. (2).to_big_integer().pow(64).
If the exponent is 0, the result is always 1; if the exponent is 1, the result is the original value.

pure function sign(): integer

Returns the sign of the integer: -1 if negative, 0 if zero, and 1 if positive.

(alias) pure function ~~signum~~(): integer

Returns the sign of the integer: -1 if negative, 0 if zero, and 1 if positive.

Alias

(alias) pure function str(): text

Converts this integer to a text string.

Alias

(alias) pure function str(radix: integer): text

Converts this integer to a text string with the specified radix.

Alias

pure function to_big_integer(): big_integer

Converts this integer to a big integer.

pure function to_decimal(): decimal

Converts this integer to a decimal.

pure function to_hex(): text

Converts this integer to a hexadecimal string.

pure function to_text(): text

Converts this integer to a text string.

pure function to_text(radix: integer): text

Converts this integer to a text string with the specified radix.